<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Dwoo_ICompiler</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Interface Dwoo_ICompiler</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">interface that represents a dwoo compiler</p>
<p class="description"><p>while implementing this is enough to interact with Dwoo/Dwoo_Templates, it is not  sufficient to interact with Dwoo_Plugins, however the main purpose of creating a  new compiler would be to interact with other/different plugins, that is why this  interface has been left with the minimum requirements.</p><p>This software is provided 'as-is', without any express or implied warranty.  In no event will the authors be held liable for any damages arising from the use of this software.</p><p>This file is released under the LGPL  &quot;GNU Lesser General Public License&quot;  More information can be found here:  <a href="http://www.gnu.org/copyleft/lesser.html">http://www.gnu.org/copyleft/lesser.html</a></p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Jordi Boggiano &lt;<a href="mailto:j.boggiano@seld.be">j.boggiano@seld.be</a>&gt;</li>
				<li><span class="field">version:</span> 0.9.1</li>
				<li><span class="field">copyright:</span> Copyright (c) 2008, Jordi Boggiano</li>
				<li><span class="field">link:</span> <a href="http://dwoo.org/">http://dwoo.org/</a></li>
				<li><span class="field">date:</span> 2008-05-30</li>
				<li><span class="field">license:</span> <a href="http://www.gnu.org/copyleft/lesser.html">GNU Lesser General Public License</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_Dwoo---ICompiler.php.html">/Dwoo/ICompiler.php</a> (line <span class="field"><a href="../__filesource/fsource_Dwoo__DwooICompiler.php.html#a27">27</a></span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																						
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#compile" title="details" class="method-name">compile</a>
											(<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>&nbsp;<span class="var-name">$dwoo</span>, <span class="var-type"><a href="../Dwoo/Dwoo_ITemplate.html">Dwoo_ITemplate</a></span>&nbsp;<span class="var-name">$template</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$templateStr</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setCustomPlugins" title="details" class="method-name">setCustomPlugins</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$customPlugins</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setSecurityPolicy" title="details" class="method-name">setSecurityPolicy</a>
											([<span class="var-type"><a href="../Dwoo/Dwoo_Security_Policy.html">Dwoo_Security_Policy</a></span>&nbsp;<span class="var-name">$policy</span> = <span class="var-default">null</span>])
									</div>
											</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodcompile" id="compile"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">compile</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooICompiler.php.html#a35">35</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">compiles the provided string down to php code</p>
	<ul class="tags">
				<li><span class="field">return:</span> a compiled php code string</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			compile
		</span>
					(<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>&nbsp;<span class="var-name">$dwoo</span>, <span class="var-type"><a href="../Dwoo/Dwoo_ITemplate.html">Dwoo_ITemplate</a></span>&nbsp;<span class="var-name">$template</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$templateStr</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$templateStr</span><span class="var-description">: the template to compile</span>			</li>
					<li>
				<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>
				<span class="var-name">$dwoo</span>			</li>
					<li>
				<span class="var-type"><a href="../Dwoo/Dwoo_ITemplate.html">Dwoo_ITemplate</a></span>
				<span class="var-name">$template</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetCustomPlugins" id="setCustomPlugins"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setCustomPlugins</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooICompiler.php.html#a43">43</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">adds the custom plugins loaded into Dwoo to the compiler so it can load them</p>
	<ul class="tags">
				<li><span class="field">see:</span> Dwoo::addPlugin</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setCustomPlugins
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$customPlugins</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$customPlugins</span><span class="var-description">: an array of custom plugins</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetSecurityPolicy" id="setSecurityPolicy"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setSecurityPolicy</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooICompiler.php.html#a53">53</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">sets the security policy object to enforce some php security settings</p>
<p class="description"><p>use this if untrusted persons can modify templates,  set it on the Dwoo object as it will be passed onto the compiler automatically</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setSecurityPolicy
		</span>
					([<span class="var-type"><a href="../Dwoo/Dwoo_Security_Policy.html">Dwoo_Security_Policy</a></span>&nbsp;<span class="var-name">$policy</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../Dwoo/Dwoo_Security_Policy.html">Dwoo_Security_Policy</a></span>
				<span class="var-name">$policy</span><span class="var-description">: the security policy object</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 30 May 2008 04:51:42 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>